#region License

// This file is part of Grawlix.
// 
// Grawlix is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as
// published by the Free Software Foundation, either version 3 of
// the License, or (at your option) any later version.
// Grawlix is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public
// License along with Grawlix.  If not, see
// <http://www.gnu.org/licenses/>.

#endregion

using C5;

namespace Grawlix.Services
{
	/// <summary>
	/// A <see cref="Domain"/> caching and indexing service.
	/// </summary>
	public interface IDomainProvider
	{
		/// <summary>
		/// Gets an immutable list of all the contained 
		/// <see cref="Domain"/> objects.
		/// </summary>
		/// <value>The domains.</value>
		IList<Domain> Domains { get; }

		/// <summary>
		/// Gets the the main controlling domain.
		/// </summary>
		/// <value>The main controlling domain.</value>
		Domain Main { get; }

		/// <summary>
		/// Finds or creates a <see cref="Domain"/> object with the
		/// specified name.
		/// </summary>
		/// <param name="name">The name of the <see cref="Domain"/>.
		/// </param>
		Domain Resolve(string name);
	}
}